home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 007a / frames11.zip / FRAMES.TXT < prev    next >
Text File  |  1991-11-07  |  23KB  |  591 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.                                        Frames
  12.  
  13.                           A Computer-Aided Instruction Tool
  14.                                      Version 1.1
  15.  
  16.  
  17.                                     User's Guide
  18.  
  19.  
  20.                        Copyright (c) 1991 by Timothy J. Weber
  21.                                     P.O. Box 6721
  22.                                   Ithaca, NY 14851
  23.  
  24.  
  25.                                    GEnie: T.WEBER4
  26.                                CompuServe: 70511,2247
  27.  
  28.  
  29.  
  30.  
  31.  
  32.                 Portions Copyright (c) 1988 by Philip A. Mongelluzzo
  33.                                Waterbury, Connecticut
  34.  
  35.  
  36.           Frames User's Guide                                   Version 1.1
  37.  
  38.  
  39.  
  40.           Contents
  41.  
  42.           Contents.................................................2
  43.           Introduction.............................................2
  44.           Shareware................................................3
  45.           System Requirements......................................3
  46.           Distribution Disk........................................4
  47.           Running Frames...........................................4
  48.           Frame Files..............................................4
  49.                Frame File Format...................................5
  50.                Entering Blanks.....................................6
  51.                Verbatim Lines......................................7
  52.                Frame File Reference................................7
  53.           Change History...........................................8
  54.                Version 1.0.........................................8
  55.                Version 1.1.........................................8
  56.                Version 1.2.........................................9
  57.           Copyright Notice and License.............................9
  58.  
  59.  
  60.  
  61.  
  62.  
  63.           Introduction
  64.  
  65.                This manual describes how to use Frames, a tool for
  66.                Computer-Aided Instruction (CAI).
  67.  
  68.                Frames implements something known as "programmed textbooks"
  69.                on the computer.  Specifically, it presents the student with
  70.                small bits of material, called "frames," and requires the
  71.                student to fill in words or phrases that have been left out.
  72.  
  73.                The concept is not as complex as other CAI methods; it
  74.                doesn't provide hints, respond to wrong answers with
  75.                explanations, grade the student's progress, take different
  76.                paths through the lesson, or use graphics or sound.  It
  77.                simply asks the student to fill in the blanks, and shows the
  78.                right answers when she has completed all the blanks on a
  79.                frame.
  80.  
  81.                This has been done in paper textbooks for many years.  What
  82.                Frames makes possible that paper doesn't is:
  83.  
  84.                     1. Easy monitoring of students' progress eliminating
  85.                        paper records or standardizing them;
  86.  
  87.                     2. Unlimited distribution of lessons, reducing the
  88.                        paper waste normally associated with workbooks; and
  89.  
  90.                     3. Easy creation of on-line tutorials by non-
  91.                        programmers.
  92.  
  93.  
  94.  
  95.                                                                           2
  96.  
  97.  
  98.           Frames User's Guide                                   Version 1.1
  99.  
  100.  
  101.                What Frames offers that other CAI programs don't is:
  102.  
  103.                     1. A simple user interface for the student.  Frames
  104.                        uses menus and dialog boxes in a familiar way.
  105.  
  106.                     2. A simple user interface for the teacher.  Lessons
  107.                        are easy to create, and no programming or macro
  108.                        language is involved.
  109.  
  110.                     3. Modest hardware requirements.  Frames can be used
  111.                        without a hard disk or a graphics monitor.
  112.  
  113.  
  114.           Shareware
  115.  
  116.                Frames is marketed as shareware.  This means that you are
  117.                free to copy it, try it, and pass it along to any and
  118.                everyone, but you must pay the author $30 if you use it.
  119.                See the end of this document for the legal details.
  120.  
  121.                To register, print out the invoice included with Frames by
  122.                typing "copy invoice.txt prn" at the DOS prompt, fill it
  123.                out, and send it with a check or money order to Timothy J.
  124.                Weber at the address listed at the top of this document and
  125.                on the program's startup screen.
  126.  
  127.                Registration is important.  There are (at least) three good
  128.                reasons to register:
  129.  
  130.                     1. It's legal.  You are granted a license to use an
  131.                        unregistered copy of this program for evaluation
  132.                        purposes for 31 days (see the end of this
  133.                        document).  If you use it beyond 31 days, you are
  134.                        violating the license agreement and breaking the
  135.                        law.
  136.  
  137.                     2. It's nice.  The author is making his living from
  138.                        user-supported software (and also helping his
  139.                        fiancee through school), and he depends on your
  140.                        registration fees to eat.
  141.  
  142.                     3. It's in your best interest.  As a registered user,
  143.                        you will be notified of future upgrades, and your
  144.                        requests for customizations or new features will
  145.                        receive careful consideration.  The more
  146.                        registrations, the sooner upgrades will occur.
  147.  
  148.  
  149.  
  150.           System Requirements
  151.  
  152.                Frames has been tested on a PC-XT compatible with 640K RAM
  153.                and a CGA, running MS-DOS 3.1, and on a BSR 386SX with 2M
  154.  
  155.  
  156.  
  157.                                                                           3
  158.  
  159.  
  160.           Frames User's Guide                                   Version 1.1
  161.  
  162.  
  163.                RAM and a VGA, running MS-DOS 3.31.  Printers are supported
  164.                in straight ASCII mode.
  165.  
  166.                Theoretically, it ought to run on any PC with a compatible
  167.                BIOS.
  168.  
  169.                Without any frame files loaded, Frames requires around 80K
  170.                of memory; it will use all available memory for frame files
  171.                up to 640K.
  172.  
  173.  
  174.           Distribution Disk
  175.  
  176.                The following files are on the distribution disk:
  177.  
  178.                     FRAMES.TXT   documentation, ASCII format
  179.                     FRAMES.EXE   the executable file
  180.                     TUTORIAL.FRA frame file for the tutorial
  181.                     INVOICE.TXT  invoice, ASCII format
  182.                     AHED.COM     The Ad Hoc Editor, by Michael Covington
  183.                     AHED.TXT     The Ad Hoc Editor documentation
  184.  
  185.  
  186.           Running Frames
  187.  
  188.                To start Frames, simply type "frames" at the DOS prompt.
  189.                You will receive instructions on how to load a tutorial on
  190.                using Frames.  All the information you need to know to use
  191.                Frames is contained in this tutorial; you should read it
  192.                before continuing to the next section of this User's Guide,
  193.                so you will understand the terms used there.
  194.  
  195.  
  196.           Frame Files
  197.  
  198.                In order to use Frames, you must first enter the information
  199.                that you want presented to your students into a file.  The
  200.                exact format of this file, called the "frame file," is
  201.                detailed below.
  202.  
  203.                There are three main restrictions on frame files:
  204.  
  205.                     1. Frame files must have an extension of ".FRA".
  206.  
  207.                     2. Frame files must be placed in the directory that is
  208.                        current when Frames is run.  If you need more
  209.                        information about directories or file names, see
  210.                        your DOS manual.  (If all your files are on one
  211.                        floppy disk, this probably won't be a problem.)
  212.  
  213.                     3. You must create frame files with an editor or word
  214.                        processor that creates "ASCII" or "flat" files.  If
  215.  
  216.  
  217.  
  218.  
  219.                                                                           4
  220.  
  221.  
  222.           Frames User's Guide                                   Version 1.1
  223.  
  224.  
  225.                        you don't have such an editor, you can use AHED,
  226.                        the "Ad Hoc Editor" [1], included with Frames.
  227.  
  228.  
  229.           Frame File Format
  230.  
  231.                Entering frames is simple: just type the text you want to
  232.                appear.  It doesn't matter where your margins are set or how
  233.                the text is formatted in the file; Frames will reformat it
  234.                so that it fits on the screen.  For example, the file
  235.                TUTORIAL.FRA (the frame file for the tutorial) has a right
  236.                margin at 60, but when you look at it with Frames, it fills
  237.                the whole 80 columns of the screen.
  238.  
  239.                You can look at TUTORIAL.FRA with AHED or your favorite
  240.                ASCII editor or browser to see examples of all the frame
  241.                file format rules.  This will make the following examples
  242.                easier to understand.
  243.  
  244.                To indicate how you want your text divided into frames,
  245.                place a period (".") on a line by itself in the first
  246.                column.  For example:
  247.  
  248.                     This is a sample frame file.
  249.                     This is its first frame.
  250.                     .
  251.                     This is its second frame.
  252.  
  253.                To separate a frame into one or more paragraphs, place a
  254.                colon (":") on a line by itself in the first column, like
  255.                this:
  256.  
  257.                     This is another sample frame file.
  258.                     This is its first frame, the first paragraph.
  259.                     :
  260.                     This is its second paragraph of the first frame.
  261.                     .
  262.                     And this is the second frame.
  263.  
  264.                By default, Frames numbers consecutively all frames and all
  265.                paragraphs after the first.  The first frame in a file and
  266.                the first paragraph in each frame is unnumbered; this is so
  267.                you can use the first frame or the first paragraph of a
  268.                frame as an introduction or title.
  269.  
  270.                If you want to change the numbering sequence, put the new
  271.                number right after the "." or the ":", like this:
  272.  
  273.  
  274.                               
  275.           [1] This is an independent product written and distributed by
  276.           Michael Covington, and is not a part of Frames.  It's in the
  277.           public domain, so you may use it free of charge.  For more
  278.           information, see the AHED.TXT file.
  279.  
  280.  
  281.                                                                           5
  282.  
  283.  
  284.           Frames User's Guide                                   Version 1.1
  285.  
  286.  
  287.                     This frame will have no number.
  288.                     :
  289.                     This paragraph will be numbered "1."
  290.                     :5
  291.                     This paragraph will be numbered "5."
  292.                     .597
  293.                     This frame will be numbered "597."
  294.  
  295.  
  296.                Also, if you don't want your paragraphs or your frames
  297.                numbered at all, you can put a "0" (zero) after the "." or
  298.                the ":", like this:
  299.  
  300.                     This frame will have no number.
  301.                     :0
  302.                     This paragraph will have no number.
  303.                     :
  304.                     This paragraph will be numbered "1."
  305.                     .0
  306.                     This frame will have no number.
  307.                     .
  308.                     This frame will be numbered "1."
  309.  
  310.  
  311.           Entering Blanks
  312.                To enter a multiple choice blank in the frame file, you need
  313.                to:
  314.  
  315.                     1. Put parentheses ("()") around the choices,
  316.  
  317.                     2. Separate them with slashes ("/"), and
  318.  
  319.                     3. Indicate the correct answer by putting an asterisk
  320.                        ("*") in front of it.
  321.  
  322.                For instance:
  323.  
  324.  
  325.                     This statement is (true/false/*don't know).  The
  326.                     correct answer is "don't know".
  327.  
  328.                To put a fill-in blank in the frame file, just put an
  329.                underscore character ("_") before and after it, like this:
  330.  
  331.                     This sentence has a fill-in _blank_.  The correct
  332.                     answer is "blank".
  333.  
  334.                You can also have fill-in blanks with multiple correct
  335.                answers, like this:
  336.  
  337.                     This sentence has a _blank/fill-in blank_.  The
  338.                     two correct answers are "blank" and "fill-in
  339.                     blank".
  340.  
  341.  
  342.  
  343.                                                                           6
  344.  
  345.  
  346.           Frames User's Guide                                   Version 1.1
  347.  
  348.  
  349.                The only restrictions on blanks are that they cannot be
  350.                longer than 80 characters so they can fit on one line of the
  351.                screen, and they cannot be broken across lines.  If you
  352.                break a blank across lines, it will be seen as just plain
  353.                text.
  354.  
  355.                There are more examples of both multiple choice and fill-in
  356.                blanks in TUTORIAL.FRA.
  357.  
  358.  
  359.           Verbatim Lines
  360.  
  361.                Frames reformats all lines by default.  If you want lines to
  362.                appear exactly as they are in the frame file, put the ">"
  363.                character in the first column.  This will force this line to
  364.                be placed on a line by itself on the screen, and spaces will
  365.                not be trimmed as they normally are.  For example, this
  366.                frame file:
  367.  
  368.                     This
  369.                     is
  370.                     formatted;
  371.                     >This
  372.                     >is
  373.                     >not.
  374.  
  375.                will look like this on the screen:
  376.  
  377.                     This is formatted;
  378.                     This
  379.                     is
  380.                     not.
  381.  
  382.  
  383.           Frame File Reference
  384.  
  385.                The special characters in frame files are:
  386.  
  387.                     .    In the first column, starts a new frame; can be
  388.                          followed by a new frame number.
  389.  
  390.                     :    In the first column, starts a new paragraph; can
  391.                          be followed by a new paragraph number.
  392.  
  393.                     ()   Surrounds a multiple-choice blank.
  394.  
  395.                     /    Separates multiple-choice answers.
  396.  
  397.                     *    Indicates the correct multiple-choice answer.
  398.  
  399.                     _    Surrounds a fill-in blank.
  400.  
  401.                     >    In the first column, indicates that this line
  402.                          should be taken verbatim.
  403.  
  404.  
  405.                                                                           7
  406.  
  407.  
  408.           Frames User's Guide                                   Version 1.1
  409.  
  410.  
  411.                Maximum line length: 255 characters.
  412.  
  413.                Maximum blank length: 80 characters.
  414.  
  415.  
  416.           Change History
  417.  
  418.  
  419.           Version 1.0
  420.  
  421.                November 1989.
  422.  
  423.                Initial release.
  424.  
  425.  
  426.           Version 1.1
  427.                November 1991.
  428.  
  429.                New features:
  430.  
  431.                     Verbatim mode.
  432.  
  433.                     Larger files are now supported.  Frames will now use
  434.                        all available memory to load frame files.
  435.  
  436.                     Use Alt now to get to a menu, not Control, for
  437.                        compatibility with popular windowing systems.
  438.                        Control is still used as the accelerator.
  439.  
  440.                     The Help menu is moved to the far right of the menu
  441.                        bar, for compatibility with popular windowing
  442.                        systems.
  443.  
  444.                Bugs fixed:
  445.  
  446.                     Question marks and exclamation points didn't get two
  447.                        spaces after them, like periods do.  Fixed.
  448.  
  449.                     Crashed when loading if memory is exhausted.  Now
  450.                        reports the problem and continues, with no frames
  451.                        loaded.
  452.  
  453.                     Allowed Save when there's no frame file loaded.  Fixed.
  454.  
  455.                     Invisible "Abort, Retry, Ignore" when trying to print
  456.                        to an offline printer.  Now reports the problem and
  457.                        allows retry or cancel.
  458.  
  459.                     Lines that start with spaces weren't formatted
  460.                        correctly.  Fixed.  There are still some other
  461.                        formatting problems, so for now, don't end a line
  462.                        with a blank unless it's the last line in the
  463.                        paragraph.
  464.  
  465.  
  466.  
  467.                                                                           8
  468.  
  469.  
  470.           Frames User's Guide                                   Version 1.1
  471.  
  472.  
  473.           Version 1.2
  474.  
  475.                Summer 1992?
  476.  
  477.                New features:
  478.  
  479.                     Replace the File Load dialog box with one that allows
  480.                        browsing through directories and picking from a
  481.                        list.
  482.  
  483.                     Mouse support.
  484.  
  485.                Bug fixes:
  486.  
  487.                     More intelligent formatting.
  488.  
  489.  
  490.           Copyright Notice and License
  491.  
  492.                This software is protected by the copyright laws of the
  493.                United States of America, as well as by the copyright laws
  494.                of many other countries pursuant to international treaties.
  495.  
  496.                Frames computer program and documentation Copyright (c) 1991
  497.                by Timothy J. Weber.  All rights reserved.  No part of the
  498.                Frames computer program, documentation or related files may
  499.                be reproduced, photocopied, stored on a retrieval system, or
  500.                transmitted except as provided by this license.
  501.  
  502.                Your first use of Frames (hereinafter referred to as "the
  503.                Software") constitutes your agreement to the following terms
  504.                of license.  Timothy J. Weber will be referred to as "the
  505.                Author."
  506.  
  507.                LIMITED LICENSE.  A limited license at no charge is granted
  508.                to use and test the Software for no more than 31 calendar
  509.                days. Thereafter, you must either pay the license fee or
  510.                cease all use of the Software.
  511.  
  512.                FULL LICENSE. When a license fee is paid, the Author will
  513.                grant a non-exclusive license to use the Software by one
  514.                natural person (the "Licensee").  Licensed copies of the
  515.                Software may be kept only on computers used by the Licensee.
  516.                No purported transfer of the license shall be effective
  517.                unless the person transferring the license (the
  518.                "Transferor") notifies the Author of the name and address of
  519.                the recipient of the license (the "Transferee").  After such
  520.                transfer of the license, the Transferor must cease all use
  521.                of the Software.
  522.  
  523.                COMMERCIAL LICENSE. Commercial organizations are granted a
  524.                limited license of 31 calendar days' duration during which
  525.                time individuals in the organization may evaluate the
  526.                Software. After this, the organization must pay the Author
  527.  
  528.  
  529.                                                                           9
  530.  
  531.  
  532.           Frames User's Guide                                   Version 1.1
  533.  
  534.  
  535.                for one the following, whichever is least:  (a) a site
  536.                license, or (b) licenses for each user of the Software, or
  537.                (c) licenses for each computer the Software is used on.
  538.                Commercial users should contact the Author for further
  539.                information.
  540.  
  541.                DUPLICATION LICENSE.  License at no charge is granted to
  542.                duplicate the Software, including, but not limited to,
  543.                placement of the Software on electronic bulletin boards and
  544.                distribution by mail, as long as (a) only a nominal charge,
  545.                not to exceed $10, is made for such duplication, and (b) the
  546.                Software is duplicated exactly as it is distributed, without
  547.                change or omission.
  548.  
  549.                UPGRADES.  The full license applies to all future versions
  550.                of the Software.  When future versions are released, the
  551.                Author will notify the Licensee by mail.  Copies of the
  552.                current version of the Software will be supplied by the
  553.                Author on request, at the cost of the distribution
  554.                materials.
  555.  
  556.                LIMITATION OF REMEDIES. Should you encounter problems with
  557.                the Software, the Author's entire liability and your
  558.                exclusive remedy shall be, at the sole option of the Author,
  559.                either (a) to terminate the license and return any license
  560.                fees that you paid the Author for the Software, or (b)
  561.                repair or replace the Software.
  562.  
  563.                DISCLAIMER OF WARRANTIES. The Author makes no claims as to
  564.                the suitability of the Software for any specific use. Except
  565.                for the Limited Warranty stated above, the Author disclaims
  566.                any and all other warranties, express or implied, oral or
  567.                written, including any implied warranties of merchantability
  568.                or fitness for a particular purpose. The limited warranty
  569.                stated above gives you specific legal rights, but you may
  570.                have other rights, which vary from state to state.
  571.  
  572.                LIMITATION OF LIABILITY. In no event shall the Author be
  573.                liable for any damages whatsoever arising out of the use of
  574.                the Software, including without limitation any direct,
  575.                incidental or consequential damages or any damages for loss
  576.                of profits, business interruption, loss of information or
  577.                any pecuniary loss, even if the Author has been advised of
  578.                the possibility of such damages. Some states do not allow
  579.                exclusion or limitation of liability for incidental or
  580.                consequential damages; therefore, the above limitation may
  581.                not apply to you.
  582.  
  583.  
  584.  
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.                                                                          10